home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / mus / play / edplyr21.lha / EdPlayer.DOCs / EdP2.1.Buttons.DOC < prev    next >
Text File  |  1992-08-28  |  23KB  |  373 lines
  1. ============================================================================
  2.  
  3.                   A N D   N O W ,   T H E   B U T T O N S :
  4.  
  5. ============================================================================
  6.  
  7. If you're reading this, I hope you have tried playing with EdPlayer a bit. 
  8. You know that there are a lot of buttons on the main panel that appears
  9. when you run the program.  Here they are, left-to-right, slowly working
  10. downward from the top.  (There are no keyboard equivalents for any of
  11. these buttons in this release.  You'll have to use your mouse.  Sorry).
  12.  
  13. POWER:  This exits EdPlayer rather immediately.  No "Are you Sure?" prompts
  14.         or anything, because they sometimes annoy me.  Of course, all the
  15.         proper shutdown routines are run, such as unloading the current
  16.         song, etc.  Note that the close gadget in the "iconified" WB window
  17.         has this same function (see ICONIFY below).
  18.         (ARexx/telled users: see KILL, SELF in ARexx section)
  19.  
  20. "T":  Tempo control.  NoiseTracker modules can have different tempos
  21.       depending on whether you are in PAL or NTSC mode.  This button
  22.       toggles between the two tempos, with the current status appearing in
  23.       the LED display.  Note that this option is memorized "per song" in
  24.       program mode (see PRG below).  Note that modules composed with
  25.       ProTracker should always be played in PAL mode.  ProTracker
  26.       always sounds like it is in PAL, even on NTSC machines.
  27.       (ARexx/telled users: see PALM, NORM, NTSC in ARexx section)
  28.  
  29. HELP:  This is the "Online Help Function."  I call it "online" because you
  30.        can get help while you are using EdPlayer.  (Of couse, this being an
  31.        Amiga, you can multitask and get help from the DOCs while you are
  32.        using EdPlayer too.  Oh, never mind.)  Anyway, you click here to
  33.        turn help on, then click on the buttons you want help with, and then
  34.        click here again to turn help back off.
  35.  
  36. "|<":  EJECTs current song, moves to previous program selection, and
  37.        displays title of that selection.  You can use this to flip through
  38.        a program, select where you want to start, and press PLAY to start.
  39.        (see PRG below).
  40.        (ARexx/telled users: see PREV in ARexx section)
  41.  
  42. ">|":  Same as "|<" above, but moves to NEXT prg selection rather than the
  43.        previous one.
  44.        NOTE: In random mode, this button jumps to a random song, not the
  45.        next one.
  46.        (ARexx/telled users: see NEXT in ARexx section)
  47.  
  48. ?:  The button with the little question mark on it is the random play
  49.     button.  It toggles a similar-looking LED.  When the LED is lit,
  50.     the current program plays in random order.  Also, the NEXT command
  51.     and the ">|" button (just above) jump to random songs rather than
  52.     the next song when this is on.  The status of the random LED is
  53.     saved when a program is saved.
  54.     (ARexx/telled users: see RAND, SAVA, SAVC in ARexx section)
  55.  
  56. PRG:  OK, now it's time to explain programs.  A "program" is a list of
  57.       module filenames that EdPlayer can memorize, along with two options
  58.       per name (PAL / NTSC and FADE / NO FADE).  When such a list exists,
  59.       EdPlayer will attempt at the end of each song to load and play the
  60.       next song in the program, using the options for that song.  The two
  61.       buttons listed above this one scroll through the program.
  62.       Now about the PRG button itself:
  63.       Be careful with this button!!  It's main use is for ERASING the
  64.       current program!  This is because CREATING programs is more easily
  65.       done with the OPEN button described below.  If EdPlayer has a program
  66.       in memory, the "PRG" LED will light up on the display.
  67. *2.0*>It is now possible to save programs!  Yay!  But not from the panel.
  68.       (aww...) Look in the ARexx Commands section for SAVA and SAVC.
  69.       (ARexx/telled users: see JUKE, ERAS, SAVA, and SAVC in ARexx section)
  70.  
  71. EJECT "^":  Unloads current song, freeing lots of CHIP memory.  Does NOT
  72.             erase current program.
  73.             (ARexx/telled users: see EJEC in ARexx section)
  74.  
  75. Fade Slide:  A tiny slider to the right of the EdPlayer logo controls
  76.              the rate at which songs fade out.  Because it is small and
  77.              its effects are large, numbers appear in the info bar at
  78.              the bottom when you use this slider.  A fade rate of 1 is
  79.              slow fade, 4 is normal fade, and higher numbers are faster
  80.              fades.  Note that if the FADE LED (yellow triangle) is not
  81.              lit, this slide is ignored, and the song does not fade at all.
  82.              Be sure to look at the description of the Fade BUTTON (below).
  83.              (ARexx/telled users: see AUTO in ARexx section)
  84.  
  85. OPEN:  For this one, you need the kd_freq.library version 3.0 or higher in
  86.        your LIBS: directory!  This library might have come with the
  87.        EdPlayer archive, because its copyright notice is as follows:
  88.  
  89. >>If you want to use 'kd_freq.library' in any freely distributable program,
  90. >>you may include the 'kd_freq.library' file as long as you also include the
  91. >>'FR_User.DOC' file and mention 'Copyright 1990  Khalid Aldoseri'.
  92.  
  93.        Oh yes, the author of this library, Khalid Aldoseri, can be reached
  94.        at the following address:
  95.                         Khalid Aldoseri
  96.                         P.O. Box 505
  97.                         Manama, Bahrain.
  98.                         Fax: (973) 694777
  99.                       Compuserve 75166,2531
  100.        And I almost forgot to mention that this library is Copyright 1990
  101.        Khalid Aldoseri.  Now that you have the kd_freq.library, you can use
  102.        the EdPlayer OPEN button to bring up it's file requester.  With this
  103.        requestor, you should select the filename of a module you want to
  104.        hear.  If there is no program, the song will load and begin to play.
  105.        However, if there IS a program (even an empty one created with PRG),
  106.        the song's name will be added to the program.  NOTE THAT A MUCH
  107.        EASIER way to make programs is with the file requester's "Extended
  108.        Select" feature.  To use this, hold down the SHIFT key and click
  109.        several module filenames.  As you click them, they light up.
  110.        (If you press shift-rightarrow, ALL the files in a dir will light up).
  111. ***>   THEN, you MUST hit the "SELECT" gadget at the top right.
  112.        When you press "OK", ALL of the filenames will be added, in
  113.        alphabetical order, to the END of the current program.  If no
  114.        program exists when you use this feature, one will automatically be
  115.        created.  To start any program, press PLAY.
  116.        NEW for EdP v1.1:  EdPlayer can now use the req.library if it can't
  117.        find the kd_freq.library.  You have to be a little more careful
  118.        with req, however:  it lets you specify drive names ("DF0:") instead
  119.        of volume names ("MyMods1:") so if you have 30 disks and you
  120.        program them all as DF0:something, you're going to be CONFUSED!!
  121. *2.0*> Various notes for v2.0 and up:
  122.        I cannot control many features of the file requesters.  All of the
  123.        file requesters are written by OTHER PEOPLE, and are only called
  124.        on by EdPlayer as libraries.  Please report bugs in a file requester
  125.        to the author of that file requester, not me!!
  126. *2.1*> asl.library now supported.  This is the standard file requestor
  127.        for Workbench 2.0 and up.
  128.        (ARexx/telled users: see LOAD, PLAY, JUKE, FREQ in ARexx section)
  129.  
  130. "<<":  Rewind button.  This button skips back to the start of the previous
  131.        position ("Pos") in the song.  If you hit it a few times, it sounds
  132.        like you are "rewinding" to an earlier part of the song.
  133.  
  134. ">>":  FastForward button.  This button skips ahead to the start of the
  135.        next position ("Pos") in the song.  You can hit it a few times
  136.        to skip over any boring parts of a song.
  137.  
  138. PLAY "|>":  This button has many functions.  If no song is loaded, it will
  139.             try to get a module name from the program and load & play it.
  140.             If a song IS loaded, but not playing, it will ignore the
  141.             program and play the current song.  If a song is ALREADY
  142.             playing, this button will PAUSE it (either immediately or
  143.             fade-to-pause, see FADE).  Finally, if a song is paused, and
  144.             you press this, the song will continue, either immediately or
  145.             fade-back-in (see FADE again).
  146.             (ARexx/telled users: see PLAY, PAUS, CONT in ARexx section)
  147.  
  148. STOP:  This button has a square on it.  It stops the music IMMEDIATELY,
  149.        regardless of the state of the "fade" light.  If you want a
  150.        fade-out, fade to a PAUSE and then press STOP.  I made it this way
  151.        because I found that in practice, when people press STOP, they just
  152.        want the music to STOP right there because they're debugging or
  153.        something, and fading is mostly for song changes in a program.
  154.        NOTE that you can NOT continue after a STOP!  You must start again
  155.        from the beginning of that song.  If you wanted to continue, you
  156.        should have pressed PAUSE (a function of the PLAY button above).
  157.        (ARexx/telled users: see STOP, FADE in ARexx section)
  158.  
  159. LOOP:  This button has a little curved arrow on it, signifying a loop.  It
  160.        will toggle on and off the similar-looking LOOP LED on the display.
  161.        When this LED is lit, the current song will loop to the beginning
  162.        (or wherever the composer decided it would loop to) and keep
  163.        playing.  In program mode, each song will come to an end, but the
  164.        whole program will loop when it runs out of titles.  When this LED
  165.        is NOT lit, the current song will end (either immediately or
  166.        fade-to-stop, see FADE) and in program mode, the program will end
  167.        when it runs out of titles (but it won't be erased).  Note that
  168.        certain MED modules have a special "STOP" command ($FFE) encoded
  169.        into the end of the song, and these modules will NEVER LOOP,
  170.        regardless of this button.
  171.        Random programs also ignore this button, they just go on selecting
  172.        songs at random and never stop...
  173.        (ARexx/telled users: see LOOP, AUTO in ARexx section)
  174.  
  175. FADE:  This button has a triangle that is supposed to signify volume fading
  176.        away (sort of).  Whenever you use PAUSE or CONTINUE, or when the
  177.        song reaches an end just before a program change, the song can
  178.        either stop/start immediately, or gradually fade out/in.
  179.        NOTE the two kinds of music modules:
  180.          1) The kind where the music comes to a nice stopping point at
  181.             the end, and doesn't need to loop.
  182.          2) The kind where the end of the score sounds like it should
  183.             keep going!  Then it loops to somewhere in the middle.  These
  184.             tunes appear to have NO stopping place, because anywhere you
  185.             stop them makes it sound abruptly cut off.
  186.        Most module players only handle the first kind of tune.  But with
  187.        EdPlayer's FADE function, a song of the second type can loop when
  188.        it reaches the end, and then fade to a stop in part of the song
  189.        you already heard (where it will be after a loop, obviously).
  190.        This puts a very nice pseudo-ending on an otherwise endless tune.
  191.        HOWEVER, if you apply this to a song of the first type, you get
  192.        something that sounds like it stops, re-starts, and then fades.
  193.        A LOT of people reported this as a BUG!  Well, it's NOT.
  194.        Just turn FADE OFF for those songs, with this nice FADE button!  The
  195.        button toggles on and off the similar-looking FADE LED on the
  196.        display.  When this LED is lit, EdPlayer will try to fade the song
  197.        as mentioned.  When this LED is dark, EdPlayer will just do instant
  198.        stops and starts.  If a song comes to an end, and LOOP is off (or
  199.        program is on) and FADE is on, the song will LOOP anyway, but begin
  200.        fading to a stop, and the program change will occour after the fade.
  201.        Note that this button has NO effect on (1) the STOP button or (2)
  202.        MED modules that have the special STOP effect ($FFE) encoded into
  203.        them.  However, these MED modules WILL trigger program changes, of
  204.        course.  SETTING the fade rate:  see the "PAUS" command in the
  205.        ARexx section!!
  206.        (ARexx/telled users: see PAUS, LOOP, AUTO, FADE in ARexx section)
  207.  
  208. FILTER OVERRIDE:  This button looks like a small arrow mushed in with the
  209.                   filter button.  It toggles a similar-looking LED.
  210.                   When lit, EdPlayer will not change the audio filter
  211.                   except for specific requests from the user such as
  212.                   the filter button or FILT command.  When not lit,
  213.                   the filter is automatically controlled by EdPlayer.
  214.                   (ARexx/telled users: see FILT in ARexx section)
  215.  
  216. FILTER:  This button looks like a dot with little waves coming out of it.
  217.          It has a similar-looking FILTER LED on the display panel that
  218.          shows the status of the Amiga's audio filter, which is also
  219.          displayed by your Amiga's so-called "power" LED.  Pressing
  220.          this button toggles the state of the audio filter.  Unless
  221.          you have filter override on, you won't need this button much,
  222.          because the filter is normally automatically handled by EdPlayer.
  223.          (ARexx/telled users: see FILT in ARexx section)
  224.  
  225. ICONIFY:  This button looks like a WB 1.3 back gadget, but it's NOT the one
  226.           in the title bar.  It gets rid of the CD-player like controls,
  227.           saving a bit of CHIP mem, and produces a tiny "iconified" window
  228.           on the WB screen.  This window has only two options: The close
  229.           gadget will exit EdPlayer (see Power above), and the right mouse
  230.           button, if pressed when the window is selected, will bring back
  231.           the CD-player look.  Of course, all the EdPlayer functions remain
  232.           in effect in this mode, like program changes and ARexx messages. 
  233.           Plus, this mode saves a bunch of CPU time, because EdPlayer can
  234.           sleep rather than updating the display every video cycle.  If you
  235.           REALLY need to conserve memory, you should hide EdPlayer
  236.           altogether and then close the WB screen, using one of the ARexx
  237.           commands and then some utility for closing WB:
  238.           (ARexx/telled users: see MENU, ICON, HIDE in ARexx section)
  239.  
  240. DISPLAY:  This button looks like a calculator 8.  It toggles between
  241.           four display modes, described in the LED Display section
  242.           (EdP2.0.LEDs.DOC)
  243.           (ARexx/telled users: see DISP in ARexx section)
  244.  
  245. BARS:  This button is mushed up with DISPLAY because it controls a
  246.        different part of the display:  The moving bars.  It cycles
  247.        the bars through three modes:  
  248.     1) Normal VU-meters, like EdPlayer 1.1a and before.  The bars display
  249.        voices 0,1,2,3 (speakers: Left, Right, Right, Left).
  250.     2) Sorted VU-meters.  The bars display voices 0,3,2,1
  251.        (speakers: Left, Left, Right, Right).  Easier to watch than (1).
  252.        (NOTE:  I recently got an A3000, and found that the audio
  253.        outputs were switched!!  The one marked "left" output the
  254.        right speaker's channel and vice versa.  I know of several
  255.        A500s and A2000s that say voices 0 and 3 are LEFT.  I checked
  256.        with the programmer's manuals (RKMs), and the 2.0 manuals
  257.        actually differ from the 1.3 manuals!!!!  What is Commodore
  258.        trying to do to us here??  Just leave the channel/speaker
  259.        assignments the way they were!!!!)
  260.     3) Spectrum Analyzer.  Thanks to Eric Parkin for drawing this.
  261.        It displays notes based on their frequency (note #).  Because there
  262.        is so little room for a wide range of notes, EdPlayer keeps track
  263.        of the collective avarage of all the notes in a song so far, and
  264.        "pans" the analyzer to focus in on the most-used range of notes.
  265.        (ARexx/telled users: see DISP in ARexx section)
  266.  
  267. MIDI:  This button is supposed to look like a MIDI plug.  Sort of.  Anyway,
  268.        it toggles MIDI on and off.  The MIDI LED on the display shows the
  269.        current status of MIDI.  When the light is off, your serial port is
  270.        free for things like downloading, etc., and when the light is on,
  271.        the serial port is allocated for MED modules to send MIDI data with.
  272.        Note to midi.library users!!!!  See "MIDL" in ARexx section!
  273.        (ARexx/telled users: see MIDI, MIDL, NOMI in ARexx section)
  274.  
  275. VOLUME SLIDE:  Well, what do YOU think it does?  It controls the volume of
  276.                a piece of music.  Also, it might NOT be such a good idea to
  277.                fuss around with this thing while the music is already
  278.                trying to FADE in/out of its own accord due to the FADE LED.
  279.                (ARexx/telled users: see VOLU in ARexx section)
  280.  
  281. EDSYNTH POPUP:  To the right of the volume slider is a small button with
  282.                 three shapes on it that are supposed to resemble piano
  283.                 keys.  This button reveals (or removes) a fun new toy
  284.                 called "EdSynth" (thank Al for the name).  EdSynth
  285.                 has a much more accurate rendition of a piano keyboard on
  286.                 it, and the keys will light up different colors as notes
  287.                 are played on them by the current song.  The color of
  288.                 the note is controlled by the instrument number playing
  289.                 it.  There may be more instruments than there are colors,
  290.                 in which case two instruments may share a color.  The
  291.                 colors in this version are: (when NOT affected by MCOL):
  292.                     Red, Green, Light Grey, Yellow, Tan, ICKY ICKY PURPLE,
  293.                     Inverted (black keys turn white, white keys turn black),
  294.                     and checkerboard (red/green mix).
  295.                 EdSynth is rather fun to watch; I recommend keeping it
  296.                 open when you don't need as much viewing area of other
  297.                 screens.
  298. *2.1*>          There is now a new mode for EdSynth, where it appears
  299.                 to the right of EdPlayer's panel rather than under it.
  300.                 It accomplishes this trick by putting the whole EdPlayer
  301.                 display into HIRES/Interlace mode.  A Flicker-fixer
  302.                 or Display Enhancer is definately recommended for
  303.                 this one.  This mode takes much less room on the
  304.                 screen than any of the older modes.  The EdSynth popup
  305.                 button cycles through the different modes.
  306.                 (ARexx/telled users: see SYNT in ARexx section)
  307.  
  308. INFO BAR:  You can click in the space between EdPlayer's "feet" to display
  309.            the name and author info of the current song.  Also, this space
  310.            shows other useful stuff like the online help, and the version
  311.            info when you first start EdPlayer or when you come out of an
  312.            Iconify or HIDE.  NOTE TO MODULE AUTHORS:  If you want to create
  313.            some "author info" to appear in this bar whenever your module
  314.            plays, there are 2 ways:  (1) For PT-MODs:  Create some
  315.            instrument names preceded by a "#".  Each instrument name in the
  316.            PT-MOD that starts with a # will be linked together (add your
  317.            own spaces!) and displayed in the bar.  (2) For MED MODs:
  318.            Create an "annotext" as the MED documentation describes.
  319. *2.0*>     As of EdPlayer v2.0, EdP will search the instrument names
  320.            of MED mods that contain them (MED 3.2 and up) and will
  321.            add any instrument names starting with a "#" to the end
  322.            of the annotext.
  323.            SPECIAL EFFECTS:  EdPlayer can handle some neat effects in the
  324.            author info of a module (NT OR MED).  These effects all start
  325.            with a <`> mark, NOT to be confused with the more ordinary <'>
  326.            mark.  PLEASE NOTICE the difference between ` and ' !!!!
  327.            The ` key, on my American keyboard, is in the top-left, just
  328.            under the ESC key.
  329.            NOTE:  Under Workbench 2.0, if you enter the ` mark on the
  330.                   CLI command line, you may need to preceed it with
  331.                   a "*", such as:  telled message *`r hello *`w there.
  332.            Here are the effects:  (lowercase letters ONLY!)
  333.                      `s  =  SLOW.  Text will scroll at 1/4 normal speed.
  334.                      `n  =  NORMAL.  Text resumes normal scroll speed.
  335.                      `f  =  FAST.  Text goes THREE TIMES normal speed!!
  336.  
  337.                      `r  =  RED.  Text from here on will be red.
  338.                      `y  =  YELLOW
  339.                      `g  =  GREEN
  340.                      `t  =  TAN   (EdPlayer's tanish color used on buttons)
  341.                      `p  =  ICKY, ICKY PURPLE!!
  342.                      `w  =  WHITE, the default.
  343.  
  344.                      ``  =  ` (if you really want a ` mark to appear).
  345.  
  346.            To use any of these effects, just insert them in the author text
  347.            of your module.  Note that using a ` mark at all will FORCE the
  348.            text to scroll, even if it was short enough to fit all on the
  349.            lo-res screen at once (NOT LIKELEY!!).
  350.            NOTE: If you play a MED mod with MCOL turned on, the colors
  351.            produced by the above effects may be different, depending on
  352.            the palette of the MED mod in question.
  353.            (ARexx/telled users: see MESS, MCOL in ARexx section)
  354.  
  355. ----------------------------------------------------------------------------
  356. The following are only visible when the EdSynth keyboard is displayed:
  357. ----------------------------------------------------------------------------
  358.  
  359. EDSYNTH BOGUS PITCHBENDER:  When my brother Al drew me a keyboard, he
  360.                 decided to write "EdSynth" on it, and he also drew
  361.                 a small pitchbender on the left side.  I left both of
  362.                 these things where they were, because they look kind of
  363.                 cool.  However, they do nothing else.  In fact, the only
  364.                 mouse-sensitive part of EdSynth is its power button.
  365.                 Obviously, EdSynth is purely for viewing pleasure.
  366.  
  367. EDSYNTH POWER:  This power button just gets rid of EdSynth, unlike the
  368.                 main EdPlayer power button which exits the whole program.
  369.                 Currently there is no way to display only EdSynth and not
  370.                 the CD panel.
  371.  
  372. That's all the buttons in this version.  Hope ya like 'em.
  373.